fix(naming, docs): change http/2 config option name #8730
+22
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 1 changed, 0 removedBuild ID: 98219b607c79f5b998cb7788 URL: https://www.apollographql.com/docs/deploy-preview/98219b607c79f5b998cb7788 |
This comment has been minimized.
This comment has been minimized.
aaronArinder
force-pushed
the
aaron/http2_header_config_name_docs
branch
from
90be0df to
f32a0b9
Compare
carodewig
reviewed
Dec 9, 2025
Contributor
carodewig
left a comment
carodewig
left a comment
There was a problem hiding this comment.
Would this benefit from a config automigration? Otherwise LGTM!
https://github.com/apollographql/router/blob/dev/apollo-router/src/configuration/migrations/README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started with a
usizefor the value of the http2 header config option and moved to aByteSizewithout updating the key name; so, updated, and backfilling docs (for some reason assumed these were auto-generated)Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
Exceptions
Note any exceptions here
Notes
Footnotes
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
A lot of (if not most) features benefit from built-in observability and
debug-level logs. Please read this guidance on metrics best-practices. ↩Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩